From: Happy-melon <happy-melon@users.mediawiki.org>
Date: Sat, 23 Apr 2011 14:16:12 +0000 (+0000)
Subject: Document SpecialPageFactory::getAliasList()
X-Git-Tag: 1.31.0-rc.0~30607
X-Git-Url: http://git.cyclocoop.org/%22.%24info%5B?a=commitdiff_plain;h=6ee86c50a6896cb9d51298660eb45c88068a2f96;p=lhc%2Fweb%2Fwiklou.git

Document SpecialPageFactory::getAliasList()
---

diff --git a/includes/SpecialPageFactory.php b/includes/SpecialPageFactory.php
index 21590f177e..b12be2666d 100644
--- a/includes/SpecialPageFactory.php
+++ b/includes/SpecialPageFactory.php
@@ -192,7 +192,12 @@ class SpecialPageFactory {
 	}
 
 	/**
-	 * @return array
+	 * Initialise and return the list of special page aliases.  Returns an object with
+	 * properties which can be accessed $obj->pagename - each property is an array of
+	 * aliases; the first in the array is the cannonical alias.  All registered special
+	 * pages are guaranteed to have a property entry, and for that property array to
+	 * contain at least one entry (English fallbacks will be added if necessary).
+	 * @return Object
 	 */
 	static function getAliasList() {
 		if ( !is_object( self::$mAliases ) ) {